home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 006a / fdude30.zip / FILEDUDE.DOC < prev    next >
Text File  |  1993-03-21  |  19KB  |  618 lines
  1.  
  2.  
  3.  
  4.                 F I L E D U D E
  5.                   version 3.0
  6.  
  7.         "The final answer to the Renegade file management woes."
  8.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  9.            Copyright (C) 1992,1993 Edhanced Software
  10.                   All rights reserved
  11.  
  12.                written by Edward Stangler
  13.  
  14.  
  15.                 Operating Manual
  16.  
  17.  
  18.   ____________________________________________________________________________
  19.   
  20.  
  21.   Contents:
  22.  
  23.   __________________________________________________________
  24.   Introduction
  25.  
  26.     What FileDude does ............................... 1
  27.  
  28.     Special thanks ................................... 1
  29.  
  30.     Features ......................................... 1  
  31.  
  32.   __________________________________________________________
  33.   Usage
  34.  
  35.     Quick Start ...................................... 2
  36.  
  37.     Commands ......................................... 3
  38.  
  39.     In-Depth Command Summaries ....................... 4
  40.  
  41.   __________________________________________________________
  42.   Miscellaneous
  43.  
  44.     Registration ..................................... 9
  45.  
  46.     Legal information ............................... 10
  47.  
  48.  
  49.   ____________________________________________________________________________
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.   FileDude v3.0 _________________________________________________ Introduction
  60.  
  61.  
  62.  
  63.   What FileDude does...
  64.   ~~~~~~~~~~~~~~~~~~~~~
  65.  
  66.     FileDude is the final answer to your Renegade file management woes.
  67.   The original purpose of this utility was to just plain upload. Over the
  68.   past few months, however, it's grown to do much more.
  69.  
  70.     FileDude v3.0 does just about everything you need to adequately         
  71.   maintain your file lists (.DIRs) and fix them when disaster strikes.          
  72.   It does not promise miracles - but it goes further than Renegade will.
  73.  
  74.  
  75.   Special thanks
  76.   ~~~~~~~~~~~~~~
  77.  
  78.     I'd like to thank all the beta sites for testing FileDude and 
  79.   putting up with the small problems and inconsistencies. Your comments
  80.   paid off in the end.
  81.  
  82.     I'd like to extend a large "Thank You!" to Craig Landgraf. Yes,
  83.   Cott - Craig Landgraf. FileDude would not have been released if it
  84.   wasn't for him. In fact, FileDude was created because Craig mentioned
  85.   (or rather hinted) he'd like to have such a utility. Thanks!
  86.  
  87.  
  88.   Features
  89.   ~~~~~~~~
  90.  
  91.     Major features:
  92.  
  93.     o  Automatic upload of files not listed in .DIRs
  94.  
  95.     o  Finding and applying any internal descriptive files,
  96.        such as FILE_ID.DIZ and DESC.SDI
  97.  
  98.     o  Applying descriptions for files from a descriptive file list,
  99.        such as FILES.BBS
  100.  
  101.     o  Conversion of all archives to a default archive type
  102.      
  103.     o  Extremely flexible file lister, utilizing several "template"
  104.        files to provide the SysOp with complete control over the 
  105.        look of the file lists
  106.     
  107.  
  108.  
  109.  
  110.   ____________________________________________________________________________
  111.   FileDude v3.0                      Page 1                       Introduction
  112.  
  113.  
  114.  
  115.   FileDude v3.0 _________________________________________________ Introduction
  116.  
  117.  
  118.  
  119.     Fixing features:
  120.  
  121.     o  Fixing file sizes
  122.     o  Fixing OFFLINE status flag to show whether a file actually
  123.        exists or not
  124.     o  Deleting entries with the OFFLINE status flag
  125.     o  Fixing vpointers (extended description pointers)
  126.     o  Delete blank or NULL entries
  127.  
  128.     Other features:
  129.  
  130.     o  Set validation of uploads
  131.     o  Set or change file points on all or uploaded files
  132.     o  Exclude or include on certain directories or files
  133.  
  134.  
  135.  
  136.   Quick Start
  137.   ~~~~~~~~~~~
  138.  
  139.     The best way to see all the commands is to just run FileDude with
  140.   no parameters. This will bring up pages of help, designed to be straight
  141.   and to the point. 
  142.  
  143.     The basic syntax for what you'll probably need is:
  144.  
  145.  
  146.     FILEDUDE /LISTCFG=[path][FBASES.DAT] /EXTENDED=[path][EXTENDED.DAT]
  147.  
  148.     This will automatically upload any files encountered, which are not
  149.     on the .DIR lists, with the default description. It will also
  150.     fix vpointers (a default, non-changeable option).
  151.  
  152.  
  153.   The parameters you will probably most want to use are:
  154.  
  155.     /OG  - Only upload when non-default description found
  156.     /ID  - Try to find FILE_ID.DIZ inside uploaded archives
  157.     /IDM - Try to find FILE_ID.DIZ inside archives already in .DIRs
  158.     /NU  - Don't upload at all
  159.     /UI  - Ask me for the descriptions!
  160.     /FS  - Fix file sizes
  161.     /FO  - Fix OFFLINE flags
  162.     /DO  - Delete files with OFFLINE flags
  163.     
  164.  
  165.  
  166.   ____________________________________________________________________________
  167.   FileDude v3.0                      Page 2                              Usage
  168.  
  169.  
  170.  
  171.   FileDude v3.0 ________________________________________________________ Usage
  172.  
  173.  
  174.  
  175.   Commands
  176.   ~~~~~~~~
  177.  
  178.   Syntax: 
  179.  
  180.     FILEDUDE /LIST=[file area listing] /DIR=[directory spec]
  181.     or
  182.     FILEDUDE /LISTCFG=[file area configuration]
  183.  
  184.   
  185.   Options:
  186.     
  187.   /UI  - Ask for descriptions                 /NU - Don't upload
  188.   /FO  - Fix OFFLINE                          /NN - Don't mark as new
  189.   /FS  - Fix SIZE                             /NV - Don't validate
  190.   /DO  - Delete OFFLINE                       /NF - Don't remove description
  191.   /ID  - Scan uploads for FILE_ID.DIZ               file (FILES.BBS)
  192.   /IDM - Scan existing for FILE_ID.DIZ        /NC - Don't delete original
  193.   /OG  - Only upload when description               archive after converting
  194.      found (not default or user input)
  195.  
  196.   /EXTENDED= - Use [path][filename] (EXTENDED.DAT) to store extended
  197.            descriptions; required if using /ID, /IDM, /ID=, or /IDM=
  198.  
  199.   /FILELIST= - Generate list of files called [path][filename]
  200.   /T=        - Use templates ending with [3-letter extension]
  201.  
  202.  
  203.   Advanced switches:
  204.  
  205.   /AUTO=     - Use [path][filename] (FILEDUDE.DAT) for directories to process
  206.   /EXEMPT=   - Use [path][filename] (EXEMPT.CFG) for omitting filespecs
  207.   /DESC=     - Use [filename] (FILES.BBS) for descriptions
  208.  
  209.   /CONVTO=   - Convert all archives to [3-letter arctype]
  210.  
  211.   /ID=       - Scan uploads for [filename] internal description file
  212.   /IDM=      - Scan existing for [filename] internal description file
  213.  
  214.   /FP=       - Points per 1k (default: FREE) (Can be a decimal) for uploaded
  215.   /FPM=      - Points per 1k (default: FREE) (Can be a decimal) for existing
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.   ____________________________________________________________________________
  223.   FileDude v3.0                      Page 3                              Usage
  224.  
  225.  
  226.  
  227.   FileDude v3.0 ________________________________________________________ Usage
  228.  
  229.  
  230.  
  231.   In-Depth Command Summaries
  232.   ~~~~~~~~~~~~~~~~~~~~~~~~~~
  233.  
  234.   /UI  - Ask for descriptions
  235.  
  236.     If unable to find a non-default description, FileDude will prompt
  237.     you for a description. Several Renegade-like commands are 
  238.     available:
  239.  
  240.     .S - Skip to next file
  241.     .D - Delete current file from DOS
  242.     .N - Go to next file area (skip current file, too)
  243.     .  - Quit FileDude immediately
  244.  
  245.     \  - (Placed at beginning of description)
  246.          Enter an extended description. Though FileDude will keep
  247.          allowing you to enter lines until a blank line is encountered,
  248.          only the first 4 lines of an extended description will be
  249.          saved (making 5 lines total for a description.)
  250.  
  251.  
  252.   /FO  - Fix OFFLINE
  253.  
  254.     FileDude will check all files to see whether they really exist or
  255.     not. The OFFLINE flags are updated accordingly. File dates
  256.     are updated only if a file's OFFLINE flag is incorrect.
  257.  
  258.  
  259.   /FS  - Fix SIZE
  260.  
  261.     FileDude will check all files to see whether the .DIR has the
  262.     correct file sizes. File dates are updated only if the file size
  263.     is incorrect.
  264.  
  265.  
  266.   /DO  - Delete OFFLINE
  267.  
  268.     FileDude will delete any files which have an OFFLINE flag. First,
  269.     however, FileDude will check to see whether a file actually 
  270.     exists or not.
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.   ____________________________________________________________________________
  279.   FileDude v3.0                      Page 4                              Usage
  280.  
  281.  
  282.  
  283.   FileDude v3.0 ________________________________________________________ Usage
  284.  
  285.  
  286.  
  287.   /ID  - Scan uploads for FILE_ID.DIZ 
  288.  
  289.     An attempt to extract FILE_ID.DIZ from any uploaded archives will
  290.     be made. If FILE_ID.DIZ is found, it will be used for the
  291.     description. It overrides the default and FILES.BBS descriptions.
  292.     The ARCHIVE.CFG file must exist in the FileDude directory to use
  293.     this feature.
  294.  
  295.  
  296.   /IDM - Scan existing for FILE_ID.DIZ
  297.  
  298.     An attempt to extract FILE_ID.DIZ from all archives will be made.
  299.     If FILE_ID.DIZ is found, the description will be tested against
  300.     the existing description. If they do not match, the extracted
  301.     description will be applied. It overrides the default and 
  302.     FILES.BBS descriptions. The ARCHIVE.CFG file must exist in the 
  303.     FileDude directory to use this feature.
  304.  
  305.  
  306.   /OG  - Only upload when description found (not default or user input)
  307.  
  308.     FileDude will only upload files when it finds a non-default
  309.     description automatically. In other words, if it doesn't have
  310.     to use the default description or ask the user for input, the
  311.     file will be uploaded. Great parameter!!
  312.  
  313.  
  314.   /NU - Don't upload
  315.  
  316.     FileDude will not upload at all. Not for a million dollars.
  317.     Not for all the file points in the universe. No siree -
  318.     NOT AT ALL! :)
  319.  
  320.     
  321.   /NN - Don't mark as new
  322.  
  323.     FileDude will not update the date of any file whatsoever.
  324.  
  325.  
  326.   /NV - Don't validate
  327.  
  328.     FileDude will not validate any file uploaded. No siree - 
  329.     it will not budge. It will stand fast in the face of
  330.     adversity. It will... it will... well, you get the point.               
  331.  
  332.  
  333.  
  334.   ____________________________________________________________________________
  335.   FileDude v3.0                      Page 5                              Usage
  336.  
  337.  
  338.  
  339.   FileDude v3.0 ________________________________________________________ Usage
  340.  
  341.  
  342.  
  343.   /NF - Don't remove description file (FILES.BBS)
  344.  
  345.     FileDude will not remove any description file. It will
  346.     spare the bytes of any FILES.BBS-type file it encounters.
  347.  
  348.  
  349.   /NC - Don't delete original archive after converting
  350.  
  351.     When FileDude converts an archive, it will not delete the
  352.     original. Great in case lightning strikes the computer. :)
  353.  
  354.  
  355.   /EXTENDED= - Use [path][filename] (EXTENDED.DAT) to store extended
  356.            descriptions; required if using /ID, /IDM, /ID=, or /IDM=
  357.  
  358.     This parameters will probably be a MUST for anything you do.
  359.     It tells FileDude where to find the extended description storage
  360.     file.
  361.  
  362.  
  363.   /FILELIST= - Generate list of files called [path][filename]
  364.  
  365.     FileDude will generate a list of files using the "template"
  366.     files (see /T= parameter).
  367.  
  368.     FileDudeMCI codes (used in the templates) are as follows.
  369.     Consistency with Renegade's MCI code system has been attempted.
  370.  
  371.     MCI CODES ARE CASE SENSITIVE!
  372.  
  373.     @a      Current date which file list is being compiled on
  374.     @r      Date that file was uploaded
  375.  
  376.     @x      Name of current file being processed
  377.     @y      Size of current file being processed
  378.     @z      Description of current file being processed
  379.  
  380.     @Y      Name of current file area being processed
  381.     @v      Total bytes in current file area processed to that point
  382.     @w      Total number of files in current file area processed to that
  383.         point
  384.  
  385.     @s      Total bytes processed to that point
  386.     @t      Total number of files processed to that point
  387.     @u      Total number of directories process to that point
  388.  
  389.  
  390.   ____________________________________________________________________________
  391.   FileDude v3.0                      Page 6                              Usage
  392.  
  393.  
  394.  
  395.   FileDude v3.0 ________________________________________________________ Usage
  396.  
  397.  
  398.  
  399.     @1      Extended description of current file - Line #1
  400.     @2      Extended description of current file - Line #2
  401.     @3      Extended description of current file - Line #3
  402.     @4      Extended description of current file - Line #4
  403.  
  404.  
  405.   /T=        - Use templates ending with [3-letter extension]
  406.  
  407.     Template files with this 3-letter extension will be used in
  408.     making the file list. ANS, ASC, and AVT are three popular
  409.     extensions. As you might have guess, this refers to what
  410.     type of coloring system, etc. used. 
  411.  
  412.     The following template files are currently used by FileDude:
  413.     (replace 'xxx' with the 3-letter extension)     
  414.  
  415.     HEADERS.xxx - Before file list
  416.  
  417.             This file is displayed before any of the files
  418.             are listed. Typically, one could use this for
  419.             BBS advertisement, message to users, file list   
  420.             title, general introduction, etc.
  421.  
  422.     PREBODY.xxx - Just before directory
  423.  
  424.             This file is displayed before each .DIR listing
  425.             of files. It contains the directory 
  426.             description, header info on the file info, etc.
  427.  
  428.     BODY.xxx    - Displayed for file entry without extended description
  429.  
  430.             For every file entry which does NOT have an 
  431.             extended description, this file is displayed.   
  432.  
  433.     BODYE#.xxx  - Displayed for file entry WITH '#' of extended lines
  434.  
  435.             For every file entry which DOES have an extended
  436.             description, this file is displayed. The '#'
  437.             is replaced with the number of lines of the
  438.             extended description.
  439.  
  440.     POSTBODY.xxx - Just after directory
  441.  
  442.             This file is displayed right after each .DIR's
  443.             files are all displayed. Totals, etc. are included.
  444.             
  445.  
  446.   ____________________________________________________________________________
  447.   FileDude v3.0                      Page 7                              Usage
  448.  
  449.  
  450.  
  451.   FileDude v3.0 ________________________________________________________ Usage
  452.  
  453.  
  454.  
  455.     FOOTERS.xxx - After file list
  456.  
  457.             This file is displayed after the file list. Totals
  458.             are also included in this file.
  459.  
  460.  
  461.   /AUTO=     - Use [path][filename] (FILEDUDE.DAT) for directories to process
  462.  
  463.         FileDude will include all .DIRs listed in this file.
  464.         An entry in this file looks like this:
  465.  
  466.         [name of .DIR file, without the extension]
  467.         [DOS directory containing the files]
  468.  
  469.         If the /LISTCFG= parameter is used, the second line
  470.         of the above entry may be omitted.
  471.  
  472.  
  473.   /EXEMPT=   - Use [path][filename] (EXEMPT.CFG) for omitting filespecs
  474.  
  475.         Filespecs on each line of this file will be omitted.
  476.         Example:
  477.  
  478.         *.GIF
  479.         FDUDE30.ARJ
  480.         WOW.*
  481.  
  482.         (files matching those criteria would not be processed.)
  483.  
  484.  
  485.   /DESC=     - Use [filename] (FILES.BBS) for descriptions
  486.  
  487.         FileDude will read this file for descriptions. These
  488.         descriptions will be used for uploads and to update
  489.         existing files. Even if some files in this list do
  490.         not actually exist, they will be uploaded. File dates
  491.         will be updated.
  492.  
  493.         The format for an entry in this file is:
  494.  
  495.         [filename]     [description]
  496.  
  497.         (The number of spaces between [filename] and
  498.         [description] may be any number greater than 0)         
  499.  
  500.  
  501.  
  502.   ____________________________________________________________________________
  503.   FileDude v3.0                      Page 8                              Usage
  504.  
  505.  
  506.  
  507.   FileDude v3.0 ________________________________________________________ Usage
  508.  
  509.  
  510.  
  511.   /CONVTO=   - Convert all archives to [3-letter arctype]
  512.  
  513.         If a file's archive type isn't this one, FileDude
  514.         will convert it. Any errors will prevent any update
  515.         to the .DIR file. If the target archive already exists,
  516.         there's an error. The ARCHIVE.CFG file must exist in the
  517.         FileDude directory to use this parameter.
  518.  
  519.  
  520.   /ID=       - Scan uploads for [filename] internal description file
  521.  
  522.         Same as /ID parameter, except you substitute a 
  523.         [filename] for FILE_ID.DIZ.
  524.  
  525.  
  526.   /IDM=      - Scan existing for [filename] internal description file
  527.  
  528.         Same as /IDM parameter, except you substitute a
  529.         [filename] for FILE_ID.DIZ.
  530.  
  531.  
  532.   /FP=       - Points per 1k (default: FREE) (Can be a decimal) for uploaded
  533.  
  534.         FileDude will set these amount of file points per
  535.         ever 1k for each file uploaded. Decimals are 
  536.         allowed. 0.5 file points per 1k = 2k per 1 file point
  537.  
  538.  
  539.   /FPM=      - Points per 1k (default: FREE) (Can be a decimal) for existing
  540.  
  541.         Same as /FP=, except FileDude alters existing files.
  542.  
  543.  
  544.  
  545.   Registration
  546.   ~~~~~~~~~~~~
  547.     I've spent many months working on this program. It's saved me 
  548.   hundreds of hours maintaining my bulletin board system - as I'm sure it
  549.   will do for you. So if you find this utility useful, PLEASE register
  550.   it. It's simple: just fill out the REGISTER.FRM file, print it out,
  551.   include $15, and send the envelope to:
  552.  
  553.     Edward G. Stangler
  554.     P.O. Box 38553, Suite #247
  555.     Houston, TX   77238-8553
  556.  
  557.  
  558.   ____________________________________________________________________________
  559.   FileDude v3.0                      Page 9                      Miscellaneous
  560.  
  561.  
  562.  
  563.   FileDude v3.0 ________________________________________________ Miscellaneous
  564.  
  565.  
  566.  
  567.   Legal Information
  568.   ~~~~~~~~~~~~~~~~~
  569.  
  570.   All brand and product names referenced in this document are trademarks, 
  571.   registered trademarks, or copyrighted works of their respective holders.
  572.  
  573.  
  574.   
  575.   This software and documentation is protected by both United States copyright 
  576.   law and international treaty provisions. 
  577.  
  578.   You are free to make copies of the software and documentation, however, all 
  579.   materials relating to this license statement, software, documentation, order  
  580.   information, copyright and trademark statements  must remain intact as 
  581.   supplied in the original shareware package. You may not distribute, rent, 
  582.   sublicense, integrate or lease the software or the documentation. You may 
  583.   not alter, modify, or adapt the software or documentation, including but not 
  584.   limited to translating, decompiling, reverse assembling, or creating 
  585.   derivative works. 
  586.   
  587.   The author disclaims all warranties, either express or implied, including 
  588.   but not limited to implied warranties of merchantability and fitness for a 
  589.   particular purpose, with  respect to the software and any accompanying 
  590.   written materials. In no event shall the author be liable for any damages 
  591.   whatsoever (including, without limitation, damages for loss of business 
  592.   profits, business interruption, loss of business information, or other 
  593.   pecuniary  loss) arising  out of the use and/or misuse of this product, even 
  594.   if the author has been advised of the possibility of such damages. Because
  595.   some states do not allow the exclusion or limitation of liability for 
  596.   consequential or incidental damages, the above limitations may not apply to 
  597.   you.
  598.  
  599.  
  600.  
  601.  
  602.   Whew!! Now, go enjoy this program!
  603.  
  604.  
  605.   Edward Stangler, author of Filedude
  606.                      
  607.   CompuServe: 74620,2333                        Call our support board:
  608.                        
  609.   Fidonet: 1:106/1076                           Mr. Ed's Corner
  610.   ITCnet:  85:841/805                           (713) 447-6119
  611.   SGA-Net: 30:30/0                              300-19200 bps
  612.  
  613.  
  614.   ____________________________________________________________________________
  615.   FileDude v3.0                     Page 10                      Miscellaneous
  616.  
  617.  
  618.